Migrate metrics_view to explore resources (breaking)
#5722
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Sep 18, 2024
* Refactor StateManagers to use explore * Replace useMetricsView - Pass 1 * Use explore in state defaults * Add basic explore editor * Replace metricViewName with exploreName where applicable in rill dev * Update bookmarks * Fix navigation on cloud * Fix alerts and reports * Migrate Public URLs * Redirect old Explore URLs to `.../explore/[name]` * Migrate embeds * Fix syncDimensions * Fix eslint * Fix `svelte-check` * `metricViewName` -> `metricsViewName` * `useMetricsView` -> `useMetricsViewValidSpec` * `useDashboard` -> `useMetricsView` * `useDashboardStore` -> `useExploreStore` * `useMetaMeasure` -> `useMetricsViewSpecMeasure` * Add two `+page.ts` files to `tsc` whitelist * Fix "Function called outside component initialization" * Add Metrics View icon * `MetricsExplorerIcon` -> `ExploreIcon` * Fix unit tests - Pass 1 * Fix unit tests - Pass 2 * Fix unit tests - Pass 3 * Fix tsc * Revise new files from "Add" button * Better organization of `features/explores`, `features/metrics-views` * Refactor `new-files.ts` to account for files bootstrapped from another resource * Add "Create Explore dashboard" button to Metrics Workspace * Nits * "Generate dashboard" -> "Generate metrics" * "DashboardMenuItems" -> "MetricsViewMenuItems" * `useValidExplore` -> `useExploreValidSpec` * `useValidDashboards` -> `useValidExplores` * Add YAML syntax highlighting to `ExploreEditor` * Partially fix Preview mode's Explore CTAs * Explore E2E pass 1 - Fix model and explore editing * Explore E2E pass 2 - Fix metrics editing in tests * Explore E2E pass 3 - Fix metrics editor experience * Fix eslint * Explore E2E pass 3 - Fix incorrect test migration * Avoid using useMetricsView * Fix resource->resource navigation buttons * Use the right icons * Update e2e tests * Fix missing icon * Fix navigation through top nav bar * Restore migration for billing table --------- Co-authored-by: Eric P Green <[email protected]>
AdityaHegde
approved these changes
Oct 1, 2024
k-anshul
pushed a commit
that referenced
this pull request
Oct 15, 2024
* Migrate `metrics_view` to `explore` resources (breaking) * Self review * Roll back docs changes * Web: Migrate `metrics_view` to `explore` resources (#5724) * Refactor StateManagers to use explore * Replace useMetricsView - Pass 1 * Use explore in state defaults * Add basic explore editor * Replace metricViewName with exploreName where applicable in rill dev * Update bookmarks * Fix navigation on cloud * Fix alerts and reports * Migrate Public URLs * Redirect old Explore URLs to `.../explore/[name]` * Migrate embeds * Fix syncDimensions * Fix eslint * Fix `svelte-check` * `metricViewName` -> `metricsViewName` * `useMetricsView` -> `useMetricsViewValidSpec` * `useDashboard` -> `useMetricsView` * `useDashboardStore` -> `useExploreStore` * `useMetaMeasure` -> `useMetricsViewSpecMeasure` * Add two `+page.ts` files to `tsc` whitelist * Fix "Function called outside component initialization" * Add Metrics View icon * `MetricsExplorerIcon` -> `ExploreIcon` * Fix unit tests - Pass 1 * Fix unit tests - Pass 2 * Fix unit tests - Pass 3 * Fix tsc * Revise new files from "Add" button * Better organization of `features/explores`, `features/metrics-views` * Refactor `new-files.ts` to account for files bootstrapped from another resource * Add "Create Explore dashboard" button to Metrics Workspace * Nits * "Generate dashboard" -> "Generate metrics" * "DashboardMenuItems" -> "MetricsViewMenuItems" * `useValidExplore` -> `useExploreValidSpec` * `useValidDashboards` -> `useValidExplores` * Add YAML syntax highlighting to `ExploreEditor` * Partially fix Preview mode's Explore CTAs * Explore E2E pass 1 - Fix model and explore editing * Explore E2E pass 2 - Fix metrics editing in tests * Explore E2E pass 3 - Fix metrics editor experience * Fix eslint * Explore E2E pass 3 - Fix incorrect test migration * Avoid using useMetricsView * Fix resource->resource navigation buttons * Use the right icons * Update e2e tests * Fix missing icon * Fix navigation through top nav bar * Restore migration for billing table --------- Co-authored-by: Eric P Green <[email protected]> --------- Co-authored-by: Aditya Hegde <[email protected]> Co-authored-by: Eric P Green <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
NOTE: This PR is finished but awaiting frontend refactors.
This PR contains migrations and breaking API changes for the separation of
metrics_viewandexploreresources. It should not be merged until the frontend has transitioned to consumingexploreresources. It also requires the frontend to be adapted for the changed API signatures.While this PR would break the current frontend, it does not contain any changes that are incompatible with previous CLI versions. So it is safe to merge once the frontend has been adapted for its changes.
Changes:
version: 1to the metrics view YAML generator.kind="rill.runtime.v1.MetricsView"to havekind="rill.runtime.v1.Explore".resource_typeandresource_nameproperties instead ofmetrics_view. Specifically, the changes are:resource_type: new field (set torill.runtime.v1.Explorefor existing rows)resource_name: renamed frommetrics_viewfilter: renamed frommetrics_view_filterfields: renamed frommetrics_view_fieldsGetIFrameRPC to use atypeparameter instead ofkindsince we prefer "type" in user-facing fields.GetIFrameRPC to default totype="rill.runtime.v1.Explore"instead oftype="rill.runtime.v1.MetricsView".Frontend integration notes: